﻿<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <link rel="stylesheet" href="../assets/css/yui-cssgrids-min.css">
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
    <link rel="shortcut icon" type="image/x-icon" href="../assets/favicon.ico">
    <script src="../assets/js/yui-source.js"></script>
	<title>SoundJS v1.0.0 API Documentation : Sound</title>
</head>
<body class="yui3-skin-sam">

<div id="doc">
    <div id="hd" class="yui3-g header">
        <div class="yui3-u-3-4">
            
                <h1><a href="http://createjs.site/soundjs"><img src="../assets/docs-icon-SoundJS.png" title="SoundJS"></a></h1>
            
        </div>
        <div class="yui3-u-1-4 version">
            <em>API Documentation for: 1.0.0</em>
        </div>
    </div>
    <div id="bd" class="yui3-g">

        <div class="yui3-u-1-4">
            <div id="docs-sidebar" class="sidebar apidocs">
                <div id="api-list">
    <h2 class="off-left">APIs</h2>
    <div id="api-tabview" class="tabview">
        <ul class="tabs">
            <li><a href="#api-classes">Classes</a></li>
        </ul>

        <div id="api-tabview-filter">
            <input type="search" id="api-filter" placeholder="Type to filter APIs">
        </div>

        <div id="api-tabview-panel">
            <ul id="api-classes" class="apis classes">
            
                <li><a href="AbstractPlugin.html">AbstractPlugin</a></li>
            
                <li><a href="AbstractSoundInstance.html">AbstractSoundInstance</a></li>
            
                <li><a href="AudioSprite.html">AudioSprite</a></li>
            
                <li><a href="CordovaAudioLoader.html">CordovaAudioLoader</a></li>
            
                <li><a href="CordovaAudioPlugin.html">CordovaAudioPlugin</a></li>
            
                <li><a href="CordovaAudioSoundInstance.html">CordovaAudioSoundInstance</a></li>
            
                <li><a href="ErrorEvent.html">ErrorEvent</a></li>
            
                <li><a href="Event.html">Event</a></li>
            
                <li><a href="EventDispatcher.html">EventDispatcher</a></li>
            
                <li><a href="FlashAudioLoader.html">FlashAudioLoader</a></li>
            
                <li><a href="FlashAudioPlugin.html">FlashAudioPlugin</a></li>
            
                <li><a href="FlashAudioSoundInstance.html">FlashAudioSoundInstance</a></li>
            
                <li><a href="HTMLAudioPlugin.html">HTMLAudioPlugin</a></li>
            
                <li><a href="HTMLAudioSoundInstance.html">HTMLAudioSoundInstance</a></li>
            
                <li><a href="HTMLAudioTagPool.html">HTMLAudioTagPool</a></li>
            
                <li><a href="PlayPropsConfig.html">PlayPropsConfig</a></li>
            
                <li><a href="Sound.html">Sound</a></li>
            
                <li><a href="SoundJS.html">SoundJS</a></li>
            
                <li><a href="Utility%20Methods.html">Utility Methods</a></li>
            
                <li><a href="WebAudioLoader.html">WebAudioLoader</a></li>
            
                <li><a href="WebAudioPlugin.html">WebAudioPlugin</a></li>
            
                <li><a href="WebAudioSoundInstance.html">WebAudioSoundInstance</a></li>
            
            </ul>

            <ul id="api-modules" class="apis modules">
            
                <li><a href="../modules/CreateJS.html">CreateJS</a></li>
            
                <li><a href="../modules/SoundJS.html">SoundJS</a></li>
            
            </ul>
        </div>
    </div>
</div>

            </div>
        </div>
        <div class="yui3-u-3-4">
            <div id="api-options">
        Show:
        <label for="api-show-inherited">
            <input type="checkbox" id="api-show-inherited" checked="">
            Inherited
        </label>

        <label for="api-show-protected">
            <input type="checkbox" id="api-show-protected">
            Protected
        </label>

        <label for="api-show-private">
            <input type="checkbox" id="api-show-private">
            Private
        </label>
        <label for="api-show-deprecated">
            <input type="checkbox" id="api-show-deprecated">
            Deprecated
        </label>

    </div>
            <div class="apidocs">
                <div id="docs-main">
                    <div class="content">
                        <h1>Sound Class</h1>
<div class="box meta">
    
        <div class="uses">
            Uses
            <ul class="inline commas">
                
                    <li><a href="EventDispatcher.html">EventDispatcher</a></li>
                
            </ul>
        </div>
    

    

    
        <div class="foundat">
            Defined in: <a href="../files/soundjs_Sound.js.html#l82"><code>Sound:82</code></a>
        </div>
    

    
        
            Module: <a href="../modules/SoundJS.html">SoundJS</a>
        
    

    
</div>



<div class="box intro">
    <p>The Sound class is the public API for creating sounds, controlling the overall sound levels, and managing plugins.
All Sound APIs on this class are static.</p>
<p><b>Registering and Preloading</b><br>
Before you can play a sound, it <b>must</b> be registered. You can do this with <a href="Sound.html#method_registerSound" class="crosslink">registerSound</a>,
or register multiple sounds using <a href="Sound.html#method_registerSounds" class="crosslink">registerSounds</a>. If you don&#39;t register a
sound prior to attempting to play it using <a href="Sound.html#method_play" class="crosslink">play</a> or create it using <a href="Sound.html#method_createInstance" class="crosslink">createInstance</a>,
the sound source will be automatically registered but playback will fail as the source will not be ready. If you use
<a href="http://preloadjs.com" target="_blank">PreloadJS</a>, registration is handled for you when the sound is
preloaded. It is recommended to preload sounds either internally using the register functions or externally using
PreloadJS so they are ready when you want to use them.</p>
<p><b>Playback</b><br>
To play a sound once it&#39;s been registered and preloaded, use the <a href="Sound.html#method_play" class="crosslink">play</a> method.
This method returns a <a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a> which can be paused, resumed, muted, etc.
Please see the <a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a> documentation for more on the instance control APIs.</p>
<p><b>Plugins</b><br>
By default, the <a href="WebAudioPlugin.html" class="crosslink">WebAudioPlugin</a> or the <a href="HTMLAudioPlugin.html" class="crosslink">HTMLAudioPlugin</a>
are used (when available), although developers can change plugin priority or add new plugins (such as the
provided <a href="FlashAudioPlugin.html" class="crosslink">FlashAudioPlugin</a>). Please see the <a href="Sound.html" class="crosslink">Sound</a> API
methods for more on the playback and plugin APIs. To install plugins, or specify a different plugin order, see
Sound/installPlugins.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> createjs.FlashAudioPlugin.swfPath = "../src/soundjs/flashaudio";
 createjs.Sound.registerPlugins([createjs.WebAudioPlugin, createjs.FlashAudioPlugin]);
 createjs.Sound.alternateExtensions = ["mp3"];
 createjs.Sound.on("fileload", this.loadHandler, this);
 createjs.Sound.registerSound("path/to/mySound.ogg", "sound");
 function loadHandler(event) {
     // This is fired for each sound that is registered.
     var instance = createjs.Sound.play("sound");  // play using id.  Could also use full source path or event.src.
     instance.on("complete", this.handleComplete, this);
     instance.volume = 0.5;
 }</code></pre>
<p>The maximum number of concurrently playing instances of the same sound can be specified in the "data" argument
of <a href="Sound.html#method_registerSound" class="crosslink">registerSound</a>.  Note that if not specified, the active plugin will apply
a default limit.  Currently HTMLAudioPlugin sets a default limit of 2, while WebAudioPlugin and FlashAudioPlugin set a
default limit of 100.</p>
<pre class="code prettyprint"><code> createjs.Sound.registerSound("sound.mp3", "soundId", 4);</code></pre>
<p>Sound can be used as a plugin with PreloadJS to help preload audio properly. Audio preloaded with PreloadJS is
automatically registered with the Sound class. When audio is not preloaded, Sound will do an automatic internal
load. As a result, it may fail to play the first time play is called if the audio is not finished loading. Use
the <a href="Sound.html#event_fileload" class="crosslink">fileload</a> event to determine when a sound has finished internally
preloading. It is recommended that all audio is preloaded before it is played.</p>
<pre class="code prettyprint"><code> var queue = new createjs.LoadQueue();
    queue.installPlugin(createjs.Sound);</code></pre>
<p><b>Audio Sprites</b><br>
SoundJS has added support for <a href="AudioSprite.html" class="crosslink">AudioSprite</a>, available as of version 0.6.0.
For those unfamiliar with audio sprites, they are much like CSS sprites or sprite sheets: multiple audio assets
grouped into a single file.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code>    var assetsPath = "./assets/";
    var sounds = [{
        src:"MyAudioSprite.ogg", data: {
            audioSprite: [
                {id:"sound1", startTime:0, duration:500},
                {id:"sound2", startTime:1000, duration:400},
                {id:"sound3", startTime:1700, duration: 1000}
            ]}
        }
    ];
    createjs.Sound.alternateExtensions = ["mp3"];
    createjs.Sound.on("fileload", loadSound);
    createjs.Sound.registerSounds(sounds, assetsPath);
    // after load is complete
    createjs.Sound.play("sound2");</code></pre>
<p><b>Mobile Playback</b><br>
Devices running iOS require the WebAudio context to be "unlocked" by playing at least one sound inside of a user-
initiated event (such as touch/click). Earlier versions of SoundJS included a "MobileSafe" sample, but this is no
longer necessary as of SoundJS 0.6.2.</p>
<ul>
    <li>
        In SoundJS 0.4.1 and above, you can either initialize plugins or use the <a href="WebAudioPlugin.html#method_playEmptySound" class="crosslink">playEmptySound</a>
        method in the call stack of a user input event to manually unlock the audio context.
    </li>
    <li>
        In SoundJS 0.6.2 and above, SoundJS will automatically listen for the first document-level "mousedown"
        and "touchend" event, and unlock WebAudio. This will continue to check these events until the WebAudio
        context becomes "unlocked" (changes from "suspended" to "running")
    </li>
    <li>
        Both the "mousedown" and "touchend" events can be used to unlock audio in iOS9+, the "touchstart" event
        will work in iOS8 and below. The "touchend" event will only work in iOS9 when the gesture is interpreted
        as a "click", so if the user long-presses the button, it will no longer work.
    </li>
    <li>
        When using the <a href="http://createjs.site/docs/easeljs/classes/Touch.html">EaselJS Touch class</a>,
        the "mousedown" event will not fire when a canvas is clicked, since MouseEvents are prevented, to ensure
        only touch events fire. To get around this, you can either rely on "touchend", or:
        <ol>
            <li>Set the <code>allowDefault</code> property on the Touch class constructor to <code>true</code> (defaults to <code>false</code>).</li>
            <li>Set the <code>preventSelection</code> property on the EaselJS <code>Stage</code> to <code>false</code>.</li>
        </ol>
        These settings may change how your application behaves, and are not recommended.
    </li>
</ul>

<p><b>Loading Alternate Paths and Extension-less Files</b><br>
SoundJS supports loading alternate paths and extension-less files by passing an object instead of a string for
the <code>src</code> property, which is a hash using the format <code>{extension:"path", extension2:"path2"}</code>. These labels are
how SoundJS determines if the browser will support the sound. This also enables multiple formats to live in
different folders, or on CDNs, which often has completely different filenames for each file.</p>
<p>Priority is determined by the property order (first property is tried first).  This is supported by both internal loading
and loading with PreloadJS.</p>
<p><em>Note: an id is required for playback.</em></p>
<h4>Example</h4>

<pre class="code prettyprint"><code>    var sounds = {path:"./audioPath/",
            manifest: [
            {id: "cool", src: {mp3:"mp3/awesome.mp3", ogg:"noExtensionOggFile"}}
    ]};

    createjs.Sound.alternateExtensions = ["mp3"];
    createjs.Sound.addEventListener("fileload", handleLoad);
    createjs.Sound.registerSounds(sounds);</code></pre>
<p><h3>Known Browser and OS issues</h3>
<b>IE 9 HTML Audio limitations</b><br>
<ul><li>There is a delay in applying volume changes to tags that occurs once playback is started. So if you have
muted all sounds, they will all play during this delay until the mute applies internally. This happens regardless of
when or how you apply the volume change, as the tag seems to need to play to apply it.</li>
<li>MP3 encoding will not always work for audio tags, particularly in Internet Explorer. We&#39;ve found default
encoding with 64kbps works.</li>
<li>Occasionally very short samples will get cut off.</li>
<li>There is a limit to how many audio tags you can load and play at once, which appears to be determined by
hardware and browser settings.  See HTMLAudioPlugin.MAX_INSTANCES for a safe
estimate.</li></ul>

<p><b>Firefox 25 Web Audio limitations</b></p>
<ul><li>mp3 audio files do not load properly on all windows machines, reported
<a href="https://bugzilla.mozilla.org/show_bug.cgi?id=929969" target="_blank">here</a>. <br>
For this reason it is recommended to pass another FF supported type (ie ogg) first until this bug is resolved, if
possible.</li></ul>

<p><b>Safari limitations</b><br></p>
<ul><li>Safari requires Quicktime to be installed for audio playback.</li></ul>

<p><b>iOS 6 Web Audio limitations</b><br></p>
<ul><li>Sound is initially locked, and must be unlocked via a user-initiated event. Please see the section on
Mobile Playback above.</li>
<li>A bug exists that will distort un-cached web audio when a video element is present in the DOM that has audio
at a different sampleRate.</li>
</ul>

<p><b>Android HTML Audio limitations</b><br></p>
<ul><li>We have no control over audio volume. Only the user can set volume on their device.</li>
<li>We can only play audio inside a user event (touch/click).  This currently means you cannot loop sound or use
a delay.</li></ul>

<p><b>Web Audio and PreloadJS</b><br></p>
<p><ul><li>Web Audio must be loaded through XHR, therefore when used with PreloadJS, tag loading is not possible.
This means that tag loading can not be used to avoid cross domain issues.</li><ul>

</ul></ul></div>



<div id="classdocs" class="tabview">
    <ul class="api-class-tabs">
        <li class="api-class-tab index"><a href="#index">Index</a></li>

        
            <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
        
        
            <li class="api-class-tab properties"><a href="#properties">Properties</a></li>
        
        
        
            <li class="api-class-tab events"><a href="#events">Events</a></li>
        
    </ul>

    <div>
        <div id="index" class="api-class-tabpanel index">
            <h2 class="off-left">Item Index</h2>

            
                <div class="index-section methods">
                    <h3>Methods</h3>

                    <ul class="index-list methods">
                        
                            <li class="index-item method private">
                                <a href="#method__beginPlaying">_beginPlaying</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method protected inherited">
                                <a href="#method__dispatchEvent">_dispatchEvent</a>

                                
                                
                            </li>
                        
                            <li class="index-item method private">
                                <a href="#method__getMasterVolume">_getMasterVolume</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method private">
                                <a href="#method__getMute">_getMute</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method private">
                                <a href="#method__getSrcById">_getSrcById</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method private">
                                <a href="#method__handleLoadComplete">_handleLoadComplete</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method private">
                                <a href="#method__parsePath">_parsePath</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method private">
                                <a href="#method__parseSrc">_parseSrc</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method private">
                                <a href="#method__playFinished">_playFinished</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method private">
                                <a href="#method__playInstance">_playInstance</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method private">
                                <a href="#method__registerPlugin">_registerPlugin</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method private">
                                <a href="#method__registerSound">_registerSound</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method private">
                                <a href="#method__setMasterVolume">_setMasterVolume</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method private">
                                <a href="#method__setMute">_setMute</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_addEventListener">addEventListener</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_createInstance">createInstance</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_dispatchEvent">dispatchEvent</a>

                                
                                
                            </li>
                        
                            <li class="index-item method deprecated">
                                <a href="#method_getCapabilities">getCapabilities</a>

                                
                                
                                    <span class="flag deprecated">deprecated</span>
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getDefaultPlayProps">getDefaultPlayProps</a>

                                
                                
                            </li>
                        
                            <li class="index-item method deprecated">
                                <a href="#method_getMasterVolume">getMasterVolume</a>

                                
                                
                                    <span class="flag deprecated">deprecated</span>
                                
                            </li>
                        
                            <li class="index-item method deprecated">
                                <a href="#method_getMute">getMute</a>

                                
                                
                                    <span class="flag deprecated">deprecated</span>
                                
                            </li>
                        
                            <li class="index-item method private">
                                <a href="#method_getPreloadHandlers">getPreloadHandlers</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_hasEventListener">hasEventListener</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_initializeDefaultPlugins">initializeDefaultPlugins</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method private">
                                <a href="#method_initLoad">initLoad</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_isReady">isReady</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_loadComplete">loadComplete</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_off">off</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_on">on</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_play">play</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_registerPlugins">registerPlugins</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_registerSound">registerSound</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_registerSounds">registerSounds</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_removeAllEventListeners">removeAllEventListeners</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_removeAllSounds">removeAllSounds</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_removeEventListener">removeEventListener</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_removeSound">removeSound</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_removeSounds">removeSounds</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_setDefaultPlayProps">setDefaultPlayProps</a>

                                
                                
                            </li>
                        
                            <li class="index-item method deprecated">
                                <a href="#method_setMute">setMute</a>

                                
                                
                                    <span class="flag deprecated">deprecated</span>
                                
                            </li>
                        
                            <li class="index-item method deprecated">
                                <a href="#method_setVolume">setVolume</a>

                                
                                
                                    <span class="flag deprecated">deprecated</span>
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_stop">stop</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_toString">toString</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_willTrigger">willTrigger</a>

                                
                                
                            </li>
                        
                    </ul>
                </div>
            

            
                <div class="index-section properties">
                    <h3>Properties</h3>

                    <ul class="index-list properties">
                        
                            <li class="index-item property protected inherited">
                                <a href="#property__captureListeners">_captureListeners</a>

                                
                                
                            </li>
                        
                            <li class="index-item property private">
                                <a href="#property__defaultPlayPropsHash">_defaultPlayPropsHash</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property private">
                                <a href="#property__idHash">_idHash</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property private">
                                <a href="#property__instances">_instances</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property private">
                                <a href="#property__lastID">_lastID</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property protected inherited">
                                <a href="#property__listeners">_listeners</a>

                                
                                
                            </li>
                        
                            <li class="index-item property private">
                                <a href="#property__masterVolume">_masterVolume</a>

                                
                                
                            </li>
                        
                            <li class="index-item property private">
                                <a href="#property__pluginsRegistered">_pluginsRegistered</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property private">
                                <a href="#property__preloadHash">_preloadHash</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_activePlugin">activePlugin</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_alternateExtensions">alternateExtensions</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_capabilities">capabilities</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_defaultInterruptBehavior">defaultInterruptBehavior</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_EXTENSION_MAP">EXTENSION_MAP</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property private">
                                <a href="#property_FILE_PATTERN">FILE_PATTERN</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_INTERRUPT_ANY">INTERRUPT_ANY</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_INTERRUPT_EARLY">INTERRUPT_EARLY</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_INTERRUPT_LATE">INTERRUPT_LATE</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_INTERRUPT_NONE">INTERRUPT_NONE</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_muted">muted</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_PLAY_FAILED">PLAY_FAILED</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_PLAY_FINISHED">PLAY_FINISHED</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_PLAY_INITED">PLAY_INITED</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_PLAY_INTERRUPTED">PLAY_INTERRUPTED</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_PLAY_SUCCEEDED">PLAY_SUCCEEDED</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_SUPPORTED_EXTENSIONS">SUPPORTED_EXTENSIONS</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_volume">volume</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                    </ul>
                </div>
            

            

            
                <div class="index-section events">
                    <h3>Events</h3>

                    <ul class="index-list events">
                        
                            <li class="index-item event">
                                <a href="#event_fileerror">fileerror</a>

                                
                                
                            </li>
                        
                            <li class="index-item event">
                                <a href="#event_fileload">fileload</a>

                                
                                
                            </li>
                        
                    </ul>
                </div>
            
        </div>

        
            <div id="methods" class="api-class-tabpanel">
                <h2 class="off-left">Methods</h2>

                
                    <div id="method__beginPlaying" class="method item private">
    <h3 class="name"><code>_beginPlaying</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>instance</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>playProps</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1482"><code>_beginPlaying:1482</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Begin playback. This is called immediately or after delay by Sound/playInstance.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">instance</code>
                        <span class="type"><a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a></span>
                    

                    

                    <div class="param-description">
                        <p>A <a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a> to begin playback.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">playProps</code>
                        <span class="type"><a href="PlayPropsConfig.html" class="crosslink">PlayPropsConfig</a></span>
                    

                    

                    <div class="param-description">
                        <p>A PlayPropsConfig object.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>If the sound can start playing. If there are no available channels, or the instance fails to
start, this will return false.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__dispatchEvent" class="method item protected inherited">
    <h3 class="name"><code>_dispatchEvent</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>eventObj</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>eventPhase</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method__dispatchEvent">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l380"><code>_dispatchEvent:380</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">eventObj</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="Event.html" class="crosslink">Event</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">eventPhase</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method__getMasterVolume" class="method item private">
    <h3 class="name"><code>_getMasterVolume</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
        </span>
    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l472"><code>_getMasterVolume:472</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="Sound.html#property_volume" class="crosslink">volume</a> property instead.</p>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__getMute" class="method item private">
    <h3 class="name"><code>_getMute</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l534"><code>_getMute:534</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="Sound.html#property_muted" class="crosslink">muted</a> property instead.</p>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__getSrcById" class="method item private">
    <h3 class="name"><code>_getSrcById</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>value</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
        </span>
    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1505"><code>_getSrcById:1505</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get the source of a sound via the ID passed in with a register call. If no ID is found the value is returned
instead.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">value</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The ID the sound was registered with.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
                    
                    <p>The source of the sound if it has been registered with this ID or the value that was passed in.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__handleLoadComplete" class="method item private">
    <h3 class="name"><code>_handleLoadComplete</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>event</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l766"><code>_handleLoadComplete:766</code></a>
        
        </p>


        

        
            <p>Available since 0.6.0</p>
        
    </div>

    <div class="description">
        <p>Used to dispatch fileload events from internal loading.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">event</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>A loader event.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method__parsePath" class="method item private">
    <h3 class="name"><code>_parsePath</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>value</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
        </span>
    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1237"><code>_parsePath:1237</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Parse the path of a sound. Alternate extensions will be attempted in order if the
current extension is not supported</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">value</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The path to an audio source.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
                    
                    <p>A formatted object that can be registered with the <a href="Sound.html#property_activePlugin" class="crosslink">activePlugin</a>
and returned to a preloader like <a href="http://preloadjs.com" target="_blank">PreloadJS</a>.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__parseSrc" class="method item private">
    <h3 class="name"><code>_parseSrc</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>value</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
        </span>
    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1267"><code>_parseSrc:1267</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Parse the path of a sound based on properties of src matching with supported extensions.
Returns false if none of the properties are supported</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">value</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>The paths to an audio source, indexed by extension type.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
                    
                    <p>A formatted object that can be registered with the <a href="Sound.html#property_activePlugin" class="crosslink">activePlugin</a>
and returned to a preloader like <a href="http://preloadjs.com" target="_blank">PreloadJS</a>.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__playFinished" class="method item private">
    <h3 class="name"><code>_playFinished</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>instance</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1518"><code>_playFinished:1518</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>A sound has completed playback, been interrupted, failed, or been stopped. This method removes the instance from
Sound management. It will be added again, if the sound re-plays. Note that this method is called from the
instances themselves.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">instance</code>
                        <span class="type"><a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a></span>
                    

                    

                    <div class="param-description">
                        <p>The instance that finished playback.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method__playInstance" class="method item private">
    <h3 class="name"><code>_playInstance</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>instance</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>playProps</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1445"><code>_playInstance:1445</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Play an instance. This is called by the static API, as well as from plugins. This allows the core class to
control delays.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">instance</code>
                        <span class="type"><a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a></span>
                    

                    

                    <div class="param-description">
                        <p>The <a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a> to start playing.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">playProps</code>
                        <span class="type"><a href="PlayPropsConfig.html" class="crosslink">PlayPropsConfig</a></span>
                    

                    

                    <div class="param-description">
                        <p>A PlayPropsConfig object.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>If the sound can start playing. Sounds that fail immediately will return false. Sounds that
have a delay will return true, but may still fail to play.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__registerPlugin" class="method item private">
    <h3 class="name"><code>_registerPlugin</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>plugin</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l821"><code>_registerPlugin:821</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Used by <a href="Sound.html#method_registerPlugins" class="crosslink">registerPlugins</a> to register a Sound plugin.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">plugin</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>The plugin class to install.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>Whether the plugin was successfully initialized.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__registerSound" class="method item private">
    <h3 class="name"><code>_registerSound</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>src</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
        </span>
    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l916"><code>_registerSound:916</code></a>
        
        </p>


        

        
            <p>Available since 0.6.0</p>
        
    </div>

    <div class="description">
        <p>Internal method for loading sounds.  This should not be called directly.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">src</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>The object to load, containing src property and optionally containing id and data.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
                    
                    <p>An object with the modified values that were passed in, which defines the sound.
Returns false if the source cannot be parsed or no plugins can be initialized.
Returns true if the source is already loaded.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__setMasterVolume" class="method item private">
    <h3 class="name"><code>_setMasterVolume</code></h3>

    
        <span class="paren">()</span>
    

    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l490"><code>_setMasterVolume:490</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="Sound.html#property_volume" class="crosslink">volume</a> property instead.</p>

    </div>

    

    

    
</div>

                
                    <div id="method__setMute" class="method item private">
    <h3 class="name"><code>_setMute</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>value</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l553"><code>_setMute:553</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="Sound.html#property_muted" class="crosslink">muted</a> property instead.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">value</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                    

                    

                    <div class="param-description">
                        <p>The muted value</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_addEventListener" class="method item inherited">
    <h3 class="name"><code>addEventListener</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>type</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>listener</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[useCapture]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_addEventListener">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l140"><code>addEventListener:140</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p><p>Adds the specified event listener. Note that adding multiple listeners to the same function will result in
multiple callbacks getting fired.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> displayObject.addEventListener("click", handleClick);
 function handleClick(event) {
    // Click happened.
 }</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The string type of the event.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">listener</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>An object with a handleEvent method, or a function that will be called when
the event is dispatched.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[useCapture]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>For events that bubble, indicates whether to listen for the event in the capture or bubbling/target phase.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
                    
                    <p>Returns the listener for chaining or assignment.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_createInstance" class="method item">
    <h3 class="name"><code>createInstance</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>src</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[startTime=null]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[duration=null]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a></span>
        </span>
    

    

    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1340"><code>createInstance:1340</code></a>
        
        </p>


        

        
            <p>Available since 0.4.0</p>
        
    </div>

    <div class="description">
        <p>Creates a <a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a> using the passed in src. If the src does not have a
supported extension or if there is no available plugin, a default AbstractSoundInstance will be returned that can be
called safely but does nothing.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> var myInstance = null;
 createjs.Sound.on("fileload", handleLoad);
 createjs.Sound.registerSound("myAudioPath/mySound.mp3", "myID", 3);
 function handleLoad(event) {
     myInstance = createjs.Sound.createInstance("myID");
     // alternately we could call the following
     myInstance = createjs.Sound.createInstance("myAudioPath/mySound.mp3");
 }</code></pre>
<p>NOTE to create an audio sprite that has not already been registered, both startTime and duration need to be set.
This is only when creating a new audio sprite, not when playing using the id of an already registered audio sprite.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">src</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The src or ID of the audio.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[startTime=null]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>To create an audio sprite (with duration), the initial offset to start playback and loop from, in milliseconds.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[duration=null]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>To create an audio sprite (with startTime), the amount of time to play the clip for, in milliseconds.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a></span>:
                    
                    <p>A <a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a> that can be controlled after it is created.
Unsupported extensions will return the default AbstractSoundInstance.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_dispatchEvent" class="method item inherited">
    <h3 class="name"><code>dispatchEvent</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>eventObj</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[bubbles]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[cancelable]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_dispatchEvent">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l285"><code>dispatchEvent:285</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p><p>Dispatches the specified event to all listeners.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> // Use a string event
 this.dispatchEvent("complete");

 // Use an Event instance
 var event = new createjs.Event("progress");
 this.dispatchEvent(event);</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">eventObj</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="Event.html" class="crosslink">Event</a></span>
                    

                    

                    <div class="param-description">
                        <p>An object with a "type" property, or a string type.
While a generic object will work, it is recommended to use a CreateJS Event instance. If a string is used,
dispatchEvent will construct an Event instance if necessary with the specified type. This latter approach can
be used to avoid event object instantiation for non-bubbling events that may not have any listeners.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[bubbles]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>Specifies the <code>bubbles</code> value when a string was passed to eventObj.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[cancelable]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>Specifies the <code>cancelable</code> value when a string was passed to eventObj.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>Returns false if <code>preventDefault()</code> was called on a cancelable event, true otherwise.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getCapabilities" class="method item deprecated">
    <h3 class="name"><code>getCapabilities</code></h3>

    
        <span class="paren">()</span>
    

    

    
        <span class="flag deprecated">deprecated</span>
    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l624"><code>getCapabilities:624</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="Sound.html#property_capabilities" class="crosslink">capabilities</a> property instead.</p>

    </div>

    

    

    
</div>

                
                    <div id="method_getDefaultPlayProps" class="method item">
    <h3 class="name"><code>getDefaultPlayProps</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>src</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="PlayPropsConfig.html" class="crosslink">PlayPropsConfig</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1427"><code>getDefaultPlayProps:1427</code></a>
        
        </p>


        

        
            <p>Available since 0.6.1</p>
        
    </div>

    <div class="description">
        <p>Get the default playback properties for the passed in src or ID.  These properties are applied to all
new SoundInstances.  Returns null if default does not exist.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">src</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The src or ID used to register the audio.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="PlayPropsConfig.html" class="crosslink">PlayPropsConfig</a></span>:
                    
                    <p>returns an existing PlayPropsConfig or null if one does not exist</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getMasterVolume" class="method item deprecated">
    <h3 class="name"><code>getMasterVolume</code></h3>

    
        <span class="paren">()</span>
    

    

    
        <span class="flag deprecated">deprecated</span>
    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l483"><code>getMasterVolume:483</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="Sound.html#property_volume" class="crosslink">volume</a> property instead.</p>

    </div>

    

    

    
</div>

                
                    <div id="method_getMute" class="method item deprecated">
    <h3 class="name"><code>getMute</code></h3>

    
        <span class="paren">()</span>
    

    

    
        <span class="flag deprecated">deprecated</span>
    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l545"><code>getMute:545</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="Sound.html#property_muted" class="crosslink">muted</a> property instead.</p>

    </div>

    

    

    
</div>

                
                    <div id="method_getPreloadHandlers" class="method item private">
    <h3 class="name"><code>getPreloadHandlers</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
        </span>
    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l744"><code>getPreloadHandlers:744</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get the preload rules to allow Sound to be used as a plugin by <a href="http://preloadjs.com" target="_blank">PreloadJS</a>.
Any load calls that have the matching type or extension will fire the callback method, and use the resulting
object, which is potentially modified by Sound. This helps when determining the correct path, as well as
registering the audio instance(s) with Sound. This method should not be called, except by PreloadJS.</p>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
                    
                    <p>An object containing:</p>
<ul><li>callback: A preload callback that is fired when a file is added to PreloadJS, which provides
     Sound a mechanism to modify the load parameters, select the correct file format, register the sound, etc.</li>
     <li>types: A list of file types that are supported by Sound (currently supports "sound").</li>
     <li>extensions: A list of file extensions that are supported by Sound (see <a href="Sound.html#property_SUPPORTED_EXTENSIONS" class="crosslink">SUPPORTED_EXTENSIONS</a>).</li></ul>
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hasEventListener" class="method item inherited">
    <h3 class="name"><code>hasEventListener</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>type</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_hasEventListener">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l339"><code>hasEventListener:339</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Indicates whether there is at least one listener for the specified event type.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The string type of the event.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>Returns true if there is at least one listener for the specified event.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_initializeDefaultPlugins" class="method item">
    <h3 class="name"><code>initializeDefaultPlugins</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l862"><code>initializeDefaultPlugins:862</code></a>
        
        </p>


        

        
            <p>Available since 0.4.0</p>
        
    </div>

    <div class="description">
        <p>Initialize the default plugins. This method is automatically called when any audio is played or registered before
the user has manually registered plugins, and enables Sound to work without manual plugin setup. Currently, the
default plugins are <a href="WebAudioPlugin.html" class="crosslink">WebAudioPlugin</a> followed by <a href="HTMLAudioPlugin.html" class="crosslink">HTMLAudioPlugin</a>.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code>if (!createjs.initializeDefaultPlugins()) { return; }</code></pre>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>True if a plugin was initialized, false otherwise.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_initLoad" class="method item private">
    <h3 class="name"><code>initLoad</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>src</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | AbstractLoader</span>
        </span>
    

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l902"><code>initLoad:902</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Process manifest items from <a href="http://preloadjs.com" target="_blank">PreloadJS</a>. This method is intended
for usage by a plugin, and not for direct interaction.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">src</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>The object to load.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | AbstractLoader</span>:
                    
                    <p>An instance of AbstractLoader.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_isReady" class="method item">
    <h3 class="name"><code>isReady</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l883"><code>isReady:883</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Determines if Sound has been initialized, and a plugin has been activated.</p>
<p><h4>Example</h4>
This example sets up a Flash fallback, but only if there is no plugin specified yet.
<pre class="code prettyprint"><code>if (!createjs.Sound.isReady()) {
    createjs.FlashAudioPlugin.swfPath = "../src/soundjs/flashaudio/";
    createjs.Sound.registerPlugins([createjs.WebAudioPlugin, createjs.HTMLAudioPlugin, createjs.FlashAudioPlugin]);
}</code></pre>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>If Sound has initialized a plugin.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_loadComplete" class="method item">
    <h3 class="name"><code>loadComplete</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>src</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1208"><code>loadComplete:1208</code></a>
        
        </p>


        

        
            <p>Available since 0.4.0</p>
        
    </div>

    <div class="description">
        <p>Check if a source has been loaded by internal preloaders. This is necessary to ensure that sounds that are
not completed preloading will not kick off a new internal preload if they are played.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code>var mySound = "assetPath/asset0.ogg";
if(createjs.Sound.loadComplete(mySound) {
    createjs.Sound.play(mySound);
}</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">src</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The src or id that is being loaded.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>If the src is already loaded.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_off" class="method item inherited">
    <h3 class="name"><code>off</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>type</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>listener</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[useCapture]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_off">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l249"><code>off:249</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>A shortcut to the removeEventListener method, with the same parameters and return value. This is a companion to the
.on method.</p>
<p><b>IMPORTANT:</b> To remove a listener added with <code>on</code>, you must pass in the returned wrapper function as the listener. See 
<a href="EventDispatcher.html#method_on" class="crosslink">on</a> for an example.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The string type of the event.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">listener</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>The listener function or object.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[useCapture]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>For events that bubble, indicates whether to listen for the event in the capture or bubbling/target phase.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_on" class="method item inherited">
    <h3 class="name"><code>on</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>type</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>listener</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[scope]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[once=false]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[data]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[useCapture=false]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_on">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l173"><code>on:173</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p><p>A shortcut method for using addEventListener that makes it easier to specify an execution scope, have a listener
only run once, associate arbitrary data with the listener, and remove the listener.</p>
<p><p>This method works by creating an anonymous wrapper function and subscribing it with addEventListener.
The wrapper function is returned for use with <code>removeEventListener</code> (or <code>off</code>).</p>
<p><p><b>IMPORTANT:</b> To remove a listener added with <code>on</code>, you must pass in the returned wrapper function as the listener, or use
<a href="Event.html#method_remove" class="crosslink">remove</a>. Likewise, each time you call <code>on</code> a NEW wrapper function is subscribed, so multiple calls
to <code>on</code> with the same params will create multiple listeners.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code>    var listener = myBtn.on("click", handleClick, null, false, {count:3});
    function handleClick(evt, data) {
        data.count -= 1;
        console.log(this == myBtn); // true - scope defaults to the dispatcher
        if (data.count == 0) {
            alert("clicked 3 times!");
            myBtn.off("click", listener);
            // alternately: evt.remove();
        }
    }</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The string type of the event.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">listener</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>An object with a handleEvent method, or a function that will be called when
the event is dispatched.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[scope]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The scope to execute the listener in. Defaults to the dispatcher/currentTarget for function listeners, and to the listener itself for object listeners (ie. using handleEvent).</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[once=false]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>If true, the listener will remove itself after the first time it is triggered.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[data]</code>
                        <span class="type"></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>Arbitrary data that will be included as the second parameter when the listener is called.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[useCapture=false]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>For events that bubble, indicates whether to listen for the event in the capture or bubbling/target phase.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>:
                    
                    <p>Returns the anonymous function that was created and assigned as the listener. This is needed to remove the listener later using .removeEventListener.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_play" class="method item">
    <h3 class="name"><code>play</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>src</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>props</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a></span>
        </span>
    

    

    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1303"><code>play:1303</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Play a sound and get a <a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a> to control. If the sound fails to
play, an AbstractSoundInstance will still be returned, and have a playState of <a href="Sound.html#property_PLAY_FAILED" class="crosslink">PLAY_FAILED</a>.
Note that even on sounds with failed playback, you may still be able to call the <a href="AbstractSoundInstance.html#method_play" class="crosslink">play</a>,
method, since the failure could be due to lack of available channels. If the src does not have a supported
extension or if there is no available plugin, a default AbstractSoundInstance will still be returned, which will
not play any audio, but will not generate errors.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> createjs.Sound.on("fileload", handleLoad);
 createjs.Sound.registerSound("myAudioPath/mySound.mp3", "myID", 3);
 function handleLoad(event) {
     createjs.Sound.play("myID");
     // store off AbstractSoundInstance for controlling
     var myInstance = createjs.Sound.play("myID", {interrupt: createjs.Sound.INTERRUPT_ANY, loop:-1});
 }</code></pre>
<p>NOTE: To create an audio sprite that has not already been registered, both startTime and duration need to be set.
This is only when creating a new audio sprite, not when playing using the id of an already registered audio sprite.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">src</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The src or ID of the audio.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">props</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="PlayPropsConfig.html" class="crosslink">PlayPropsConfig</a></span>
                    

                    

                    <div class="param-description">
                        <p>A PlayPropsConfig instance, or an object that contains the parameters to
play a sound. See the <a href="PlayPropsConfig.html" class="crosslink">PlayPropsConfig</a> for more info.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a></span>:
                    
                    <p>A <a href="AbstractSoundInstance.html" class="crosslink">AbstractSoundInstance</a> that can be controlled
after it is created.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_registerPlugins" class="method item">
    <h3 class="name"><code>registerPlugins</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>plugins</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l839"><code>registerPlugins:839</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Register a list of Sound plugins, in order of precedence. To register a single plugin, pass a single element in the array.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> createjs.FlashAudioPlugin.swfPath = "../src/soundjs/flashaudio/";
 createjs.Sound.registerPlugins([createjs.WebAudioPlugin, createjs.HTMLAudioPlugin, createjs.FlashAudioPlugin]);</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">plugins</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
                    

                    

                    <div class="param-description">
                        <p>An array of plugins classes to install.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>Whether a plugin was successfully initialized.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_registerSound" class="method item">
    <h3 class="name"><code>registerSound</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>src</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[id]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[data]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>basePath</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>defaultPlayProps</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
        </span>
    

    

    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l984"><code>registerSound:984</code></a>
        
        </p>


        

        
            <p>Available since 0.4.0</p>
        
    </div>

    <div class="description">
        <p>Register an audio file for loading and future playback in Sound. This is automatically called when using
<a href="http://preloadjs.com" target="_blank">PreloadJS</a>.  It is recommended to register all sounds that
need to be played back in order to properly prepare and preload them. Sound does internal preloading when required.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> createjs.Sound.alternateExtensions = ["mp3"];
 createjs.Sound.on("fileload", handleLoad); // add an event listener for when load is completed
 createjs.Sound.registerSound("myAudioPath/mySound.ogg", "myID", 3);
 createjs.Sound.registerSound({ogg:"path1/mySound.ogg", mp3:"path2/mySoundNoExtension"}, "myID", 3);</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">src</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>The source or an Object with a "src" property or an Object with multiple extension labeled src properties.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[id]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>An id specified by the user to play the sound later.  Note id is required for when src is multiple extension labeled src properties.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[data]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>Data associated with the item. Sound uses the data parameter as the number of
channels for an audio instance, however a "channels" property can be appended to the data object if it is used
for other information. The audio channels will set a default based on plugin if no value is found.
Sound also uses the data property to hold an <a href="AudioSprite.html" class="crosslink">AudioSprite</a> array of objects in the following format {id, startTime, duration}.<br>
  id used to play the sound later, in the same manner as a sound src with an id.<br>
  startTime is the initial offset to start playback and loop from, in milliseconds.<br>
  duration is the amount of time to play the clip for, in milliseconds.<br>
This allows Sound to support audio sprites that are played back by id.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">basePath</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>Set a path that will be prepended to src for loading.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">defaultPlayProps</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="PlayPropsConfig.html" class="crosslink">PlayPropsConfig</a></span>
                    

                    

                    <div class="param-description">
                        <p>Optional Playback properties that will be set as the defaults on any new AbstractSoundInstance.
See <a href="PlayPropsConfig.html" class="crosslink">PlayPropsConfig</a> for options.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
                    
                    <p>An object with the modified values that were passed in, which defines the sound.
Returns false if the source cannot be parsed or no plugins can be initialized.
Returns true if the source is already loaded.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_registerSounds" class="method item">
    <h3 class="name"><code>registerSounds</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>sounds</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>basePath</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
        </span>
    

    

    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1045"><code>registerSounds:1045</code></a>
        
        </p>


        

        
            <p>Available since 0.6.0</p>
        
    </div>

    <div class="description">
        <p>Register an array of audio files for loading and future playback in Sound. It is recommended to register all
sounds that need to be played back in order to properly prepare and preload them. Sound does internal preloading
when required.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code>    var assetPath = "./myAudioPath/";
 var sounds = [
     {src:"asset0.ogg", id:"example"},
     {src:"asset1.ogg", id:"1", data:6},
     {src:"asset2.mp3", id:"works"}
     {src:{mp3:"path1/asset3.mp3", ogg:"path2/asset3NoExtension"}, id:"better"}
 ];
 createjs.Sound.alternateExtensions = ["mp3"];    // if the passed extension is not supported, try this extension
 createjs.Sound.on("fileload", handleLoad); // call handleLoad when each sound loads
 createjs.Sound.registerSounds(sounds, assetPath);</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">sounds</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
                    

                    

                    <div class="param-description">
                        <p>An array of objects to load. Objects are expected to be in the format needed for
<a href="Sound.html#method_registerSound" class="crosslink">registerSound</a>: <code>{src:srcURI, id:ID, data:Data}</code>
with "id" and "data" being optional.
You can also pass an object with path and manifest properties, where path is a basePath and manifest is an array of objects to load.
Note id is required if src is an object with extension labeled src properties.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">basePath</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>Set a path that will be prepended to each src when loading.  When creating, playing, or removing
audio that was loaded with a basePath by src, the basePath must be included.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
                    
                    <p>An array of objects with the modified values that were passed in, which defines each sound.
Like registerSound, it will return false for any values when the source cannot be parsed or if no plugins can be initialized.
Also, it will return true for any values when the source is already loaded.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_removeAllEventListeners" class="method item inherited">
    <h3 class="name"><code>removeAllEventListeners</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code class="optional">[type]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_removeAllEventListeners">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l263"><code>removeAllEventListeners:263</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p><p>Removes all listeners for the specified type, or all listeners of all types.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> // Remove all listeners
 displayObject.removeAllEventListeners();

 // Remove all click listeners
 displayObject.removeAllEventListeners("click");</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name optional">[type]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The string type of the event. If omitted, all listeners for all types will be removed.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_removeAllSounds" class="method item">
    <h3 class="name"><code>removeAllSounds</code></h3>

    
        <span class="paren">()</span>
    

    

    

    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1188"><code>removeAllSounds:1188</code></a>
        
        </p>


        

        
            <p>Available since 0.4.1</p>
        
    </div>

    <div class="description">
        <p>Remove all sounds that have been registered with <a href="Sound.html#method_registerSound" class="crosslink">registerSound</a> or
<a href="Sound.html#method_registerSounds" class="crosslink">registerSounds</a>.
<br>Note this will stop playback on all active sound instances before deleting them.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code>createjs.Sound.removeAllSounds();</code></pre>

    </div>

    

    

    
</div>

                
                    <div id="method_removeEventListener" class="method item inherited">
    <h3 class="name"><code>removeEventListener</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>type</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>listener</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[useCapture]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_removeEventListener">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l219"><code>removeEventListener:219</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p><p>Removes the specified event listener.</p>
<p><p><b>Important Note:</b> that you must pass the exact function reference used when the event was added. If a proxy
function, or function closure is used as the callback, the proxy/closure reference must be used - a new proxy or
closure will not work.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> displayObject.removeEventListener("click", handleClick);</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The string type of the event.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">listener</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>The listener function or object.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[useCapture]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>For events that bubble, indicates whether to listen for the event in the capture or bubbling/target phase.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_removeSound" class="method item">
    <h3 class="name"><code>removeSound</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>src</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>basePath</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1094"><code>removeSound:1094</code></a>
        
        </p>


        

        
            <p>Available since 0.4.1</p>
        
    </div>

    <div class="description">
        <p>Remove a sound that has been registered with <a href="Sound.html#method_registerSound" class="crosslink">registerSound</a> or
<a href="Sound.html#method_registerSounds" class="crosslink">registerSounds</a>.
<br>Note this will stop playback on active instances playing this sound before deleting them.
<br>Note if you passed in a basePath, you need to pass it or prepend it to the src here.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> createjs.Sound.removeSound("myID");
 createjs.Sound.removeSound("myAudioBasePath/mySound.ogg");
 createjs.Sound.removeSound("myPath/myOtherSound.mp3", "myBasePath/");
 createjs.Sound.removeSound({mp3:"musicNoExtension", ogg:"music.ogg"}, "myBasePath/");</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">src</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>The src or ID of the audio, or an Object with a "src" property, or an Object with multiple extension labeled src properties.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">basePath</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>Set a path that will be prepended to each src when removing.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>True if sound is successfully removed.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_removeSounds" class="method item">
    <h3 class="name"><code>removeSounds</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>sounds</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>basePath</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
        </span>
    

    

    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1146"><code>removeSounds:1146</code></a>
        
        </p>


        

        
            <p>Available since 0.4.1</p>
        
    </div>

    <div class="description">
        <p>Remove an array of audio files that have been registered with <a href="Sound.html#method_registerSound" class="crosslink">registerSound</a> or
<a href="Sound.html#method_registerSounds" class="crosslink">registerSounds</a>.
<br>Note this will stop playback on active instances playing this audio before deleting them.
<br>Note if you passed in a basePath, you need to pass it or prepend it to the src here.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code>    assetPath = "./myPath/";
 var sounds = [
     {src:"asset0.ogg", id:"example"},
     {src:"asset1.ogg", id:"1", data:6},
     {src:"asset2.mp3", id:"works"}
 ];
 createjs.Sound.removeSounds(sounds, assetPath);</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">sounds</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
                    

                    

                    <div class="param-description">
                        <p>An array of objects to remove. Objects are expected to be in the format needed for
<a href="Sound.html#method_removeSound" class="crosslink">removeSound</a>: <code>{srcOrID:srcURIorID}</code>.
You can also pass an object with path and manifest properties, where path is a basePath and manifest is an array of objects to remove.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">basePath</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>Set a path that will be prepended to each src when removing.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
                    
                    <p>An array of Boolean values representing if the sounds with the same array index were
successfully removed.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_setDefaultPlayProps" class="method item">
    <h3 class="name"><code>setDefaultPlayProps</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>src</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>playProps</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1413"><code>setDefaultPlayProps:1413</code></a>
        
        </p>


        

        
            <p>Available since 0.6.1</p>
        
    </div>

    <div class="description">
        <p>Set the default playback properties for all new SoundInstances of the passed in src or ID.
See <a href="PlayPropsConfig.html" class="crosslink">PlayPropsConfig</a> for available properties.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">src</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The src or ID used to register the audio.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">playProps</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="PlayPropsConfig.html" class="crosslink">PlayPropsConfig</a></span>
                    

                    

                    <div class="param-description">
                        <p>The playback properties you would like to set.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_setMute" class="method item deprecated">
    <h3 class="name"><code>setMute</code></h3>

    
        <span class="paren">()</span>
    

    

    
        <span class="flag deprecated">deprecated</span>
    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l571"><code>setMute:571</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="Sound.html#property_muted" class="crosslink">muted</a> property instead.</p>

    </div>

    

    

    
</div>

                
                    <div id="method_setVolume" class="method item deprecated">
    <h3 class="name"><code>setVolume</code></h3>

    
        <span class="paren">()</span>
    

    

    
        <span class="flag deprecated">deprecated</span>
    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l508"><code>setVolume:508</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="Sound.html#property_volume" class="crosslink">volume</a> property instead.</p>

    </div>

    

    

    
</div>

                
                    <div id="method_stop" class="method item">
    <h3 class="name"><code>stop</code></h3>

    
        <span class="paren">()</span>
    

    

    

    

    

    
        <span class="flag static">static</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l1395"><code>stop:1395</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Stop all audio (global stop). Stopped audio is reset, and not paused. To play audio that has been stopped,
call AbstractSoundInstance <a href="AbstractSoundInstance.html#method_play" class="crosslink">play</a>.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code>createjs.Sound.stop();</code></pre>

    </div>

    

    

    
</div>

                
                    <div id="method_toString" class="method item inherited">
    <h3 class="name"><code>toString</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_toString">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l370"><code>toString:370</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
                    
                    <p>a string representation of the instance.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_willTrigger" class="method item inherited">
    <h3 class="name"><code>willTrigger</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>type</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_willTrigger">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l350"><code>willTrigger:350</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Indicates whether there is at least one listener for the specified event type on this object or any of its
ancestors (parent, parent&#39;s parent, etc). A return value of true indicates that if a bubbling event of the
specified type is dispatched from this object, it will trigger at least one listener.</p>
<p>This is similar to <a href="EventDispatcher.html#method_hasEventListener" class="crosslink">hasEventListener</a>, but it searches the entire
event flow for a listener, not just this object.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The string type of the event.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>Returns <code>true</code> if there is at least one listener for the specified event.</p>

                
            </div>
        </div>
    

    
</div>

                
            </div>
        

        
            <div id="properties" class="api-class-tabpanel">
                <h2 class="off-left">Properties</h2>

                
                    <div id="property__captureListeners" class="property item protected inherited">
    <h3 class="name"><code>_captureListeners</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

    

    
        <span class="flag protected">protected</span>
    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#property__captureListeners">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l106"><code>_captureListeners:106</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        
    </div>

    

    

    
</div>

                
                    <div id="property__defaultPlayPropsHash" class="property item private">
    <h3 class="name"><code>_defaultPlayPropsHash</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l694"><code>_defaultPlayPropsHash:694</code></a>
        
        </p>

        

        
            <p>Available since 0.6.1</p>
        
    </div>

    <div class="description">
        <p>An object hash storing <a href="PlayPropsConfig.html" class="crosslink">PlayPropsConfig</a> via the parsed source that is passed as defaultPlayProps in
<a href="Sound.html#method_registerSound" class="crosslink">registerSound</a> and <a href="Sound.html#method_registerSounds" class="crosslink">registerSounds</a>.</p>

    </div>

    

    

    
</div>

                
                    <div id="property__idHash" class="property item private">
    <h3 class="name"><code>_idHash</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l674"><code>_idHash:674</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>An object hash storing objects with sound sources, startTime, and duration via there corresponding ID.</p>

    </div>

    

    

    
</div>

                
                    <div id="property__instances" class="property item private">
    <h3 class="name"><code>_instances</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l661"><code>_instances:661</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>An array containing all currently playing instances. This allows Sound to control the volume, mute, and playback of
all instances when using static APIs like <a href="Sound.html#method_stop" class="crosslink">stop</a> and <a href="Sound.html#property_volume" class="crosslink">volume</a>.
When an instance has finished playback, it gets removed via the Sound/finishedPlaying
method. If the user replays an instance, it gets added back in via the <a href="Sound.html#method__beginPlaying" class="crosslink">_beginPlaying</a>
method.</p>

    </div>

    

    

    
</div>

                
                    <div id="property__lastID" class="property item private">
    <h3 class="name"><code>_lastID</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l652"><code>_lastID:652</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Used internally to assign unique IDs to each AbstractSoundInstance.</p>

    </div>

    

    

    
</div>

                
                    <div id="property__listeners" class="property item protected inherited">
    <h3 class="name"><code>_listeners</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

    

    
        <span class="flag protected">protected</span>
    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#property__listeners">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l99"><code>_listeners:99</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        
    </div>

    

    

    
</div>

                
                    <div id="property__masterVolume" class="property item private">
    <h3 class="name"><code>_masterVolume</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    
        <span class="flag private">private</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l463"><code>_masterVolume:463</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The internal volume level. Use <a href="Sound.html#property_volume" class="crosslink">volume</a> to adjust the master volume.</p>

    </div>

    
        <p><strong>Default:</strong> 1</p>
    

    

    
</div>

                
                    <div id="property__pluginsRegistered" class="property item private">
    <h3 class="name"><code>_pluginsRegistered</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l640"><code>_pluginsRegistered:640</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Determines if the plugins have been registered. If false, the first call to Play will instantiate the default
plugins (<a href="WebAudioPlugin.html" class="crosslink">WebAudioPlugin</a>, followed by <a href="HTMLAudioPlugin.html" class="crosslink">HTMLAudioPlugin</a>).
If plugins have been registered, but none are applicable, then sound playback will fail.</p>

    </div>

    
        <p><strong>Default:</strong> false</p>
    

    

    
</div>

                
                    <div id="property__preloadHash" class="property item private">
    <h3 class="name"><code>_preloadHash</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l683"><code>_preloadHash:683</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>An object hash that stores preloading sound sources via the parsed source that is passed to the plugin.  Contains the
source, id, and data that was passed in by the user.  Parsed sources can contain multiple instances of source, id,
and data.</p>

    </div>

    

    

    
</div>

                
                    <div id="property_activePlugin" class="property item">
    <h3 class="name"><code>activePlugin</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l433"><code>activePlugin:433</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The currently active plugin. If this is null, then no plugin could be initialized. If no plugin was specified,
Sound attempts to apply the default plugins: <a href="WebAudioPlugin.html" class="crosslink">WebAudioPlugin</a>, followed by
<a href="HTMLAudioPlugin.html" class="crosslink">HTMLAudioPlugin</a>.</p>

    </div>

    

    

    
</div>

                
                    <div id="property_alternateExtensions" class="property item">
    <h3 class="name"><code>alternateExtensions</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l406"><code>alternateExtensions:406</code></a>
        
        </p>

        

        
            <p>Available since 0.5.2</p>
        
    </div>

    <div class="description">
        <p>An array of extensions to attempt to use when loading sound, if the default is unsupported by the active plugin.
These are applied in order, so if you try to Load Thunder.ogg in a browser that does not support ogg, and your
extensions array is ["mp3", "m4a", "wav"] it will check mp3 support, then m4a, then wav. The audio files need
to exist in the same location, as only the extension is altered.</p>
<p>Note that regardless of which file is loaded, you can call <a href="Sound.html#method_createInstance" class="crosslink">createInstance</a>
and <a href="Sound.html#method_play" class="crosslink">play</a> using the same id or full source path passed for loading.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code>var sounds = [
    {src:"myPath/mySound.ogg", id:"example"},
];
createjs.Sound.alternateExtensions = ["mp3"]; // now if ogg is not supported, SoundJS will try asset0.mp3
createjs.Sound.on("fileload", handleLoad); // call handleLoad when each sound loads
createjs.Sound.registerSounds(sounds, assetPath);
// ...
createjs.Sound.play("myPath/mySound.ogg"); // works regardless of what extension is supported.  Note calling with ID is a better approach</code></pre>

    </div>

    

    

    
</div>

                
                    <div id="property_capabilities" class="property item">
    <h3 class="name"><code>capabilities</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l579"><code>capabilities:579</code></a>
        
        </p>

        

        
            <p>Available since 0.6.1</p>
        
    </div>

    <div class="description">
        <p>Get the active plugins capabilities, which help determine if a plugin can be used in the current environment,
or if the plugin supports a specific feature. Capabilities include:</p>
<ul>
    <li><b>panning:</b> If the plugin can pan audio from left to right</li>
    <li><b>volume;</b> If the plugin can control audio volume.</li>
    <li><b>tracks:</b> The maximum number of audio tracks that can be played back at a time. This will be -1
    if there is no known limit.</li>
<br>An entry for each file type in <a href="Sound.html#property_SUPPORTED_EXTENSIONS" class="crosslink">SUPPORTED_EXTENSIONS</a>:
    <li><b>mp3:</b> If MP3 audio is supported.</li>
    <li><b>ogg:</b> If OGG audio is supported.</li>
    <li><b>wav:</b> If WAV audio is supported.</li>
    <li><b>mpeg:</b> If MPEG audio is supported.</li>
    <li><b>m4a:</b> If M4A audio is supported.</li>
    <li><b>mp4:</b> If MP4 audio is supported.</li>
    <li><b>aiff:</b> If aiff audio is supported.</li>
    <li><b>wma:</b> If wma audio is supported.</li>
    <li><b>mid:</b> If mid audio is supported.</li>
</ul>

<p>You can get a specific capability of the active plugin using standard object notation</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> var mp3 = createjs.Sound.capabilities.mp3;</code></pre>
<p>Note this property is read only.</p>

    </div>

    

    

    
</div>

                
                    <div id="property_defaultInterruptBehavior" class="property item">
    <h3 class="name"><code>defaultInterruptBehavior</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l393"><code>defaultInterruptBehavior:393</code></a>
        
        </p>

        

        
            <p>Available since 0.4.0</p>
        
    </div>

    <div class="description">
        <p>Determines the default behavior for interrupting other currently playing instances with the same source, if the
maximum number of instances of the sound are already playing.  Currently the default is <a href="Sound.html#property_INTERRUPT_NONE" class="crosslink">INTERRUPT_NONE</a>
but this can be set and will change playback behavior accordingly.  This is only used when <a href="Sound.html#method_play" class="crosslink">play</a>
is called without passing a value for interrupt.</p>

    </div>

    
        <p><strong>Default:</strong> Sound.INTERRUPT_NONE, or &quot;none&quot;</p>
    

    

    
</div>

                
                    <div id="property_EXTENSION_MAP" class="property item">
    <h3 class="name"><code>EXTENSION_MAP</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l365"><code>EXTENSION_MAP:365</code></a>
        
        </p>

        

        
            <p>Available since 0.4.0</p>
        
    </div>

    <div class="description">
        <p>Some extensions use another type of extension support to play (one of them is a codex).  This allows you to map
that support so plugins can accurately determine if an extension is supported.  Adding to this list can help
plugins determine more accurately if an extension is supported.</p>
<p>A useful list of extensions for each format can be found at <a href="http://html5doctor.com/html5-audio-the-state-of-play/" target="_blank"><a href="http://html5doctor.com/html5-audio-the-state-of-play/">http://html5doctor.com/html5-audio-the-state-of-play/</a>.</p>

    </div>

    
        <p><strong>Default:</strong> {m4a:&quot;mp4&quot;}</p>
    

    

    
</div>

                
                    <div id="property_FILE_PATTERN" class="property item private">
    <h3 class="name"><code>FILE_PATTERN</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>

    

    
        <span class="flag private">private</span>
    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l381"><code>FILE_PATTERN:381</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The RegExp pattern used to parse file URIs. This supports simple file names, as well as full domain URIs with
query strings. The resulting match is: protocol:$1 domain:$2 path:$3 file:$4 extension:$5 query:$6.</p>

    </div>

    

    

    
</div>

                
                    <div id="property_INTERRUPT_ANY" class="property item">
    <h3 class="name"><code>INTERRUPT_ANY</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l262"><code>INTERRUPT_ANY:262</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The interrupt value to interrupt any currently playing instance with the same source, if the maximum number of
instances of the sound are already playing.</p>

    </div>

    
        <p><strong>Default:</strong> any</p>
    

    

    
</div>

                
                    <div id="property_INTERRUPT_EARLY" class="property item">
    <h3 class="name"><code>INTERRUPT_EARLY</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l272"><code>INTERRUPT_EARLY:272</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The interrupt value to interrupt the earliest currently playing instance with the same source that progressed the
least distance in the audio track, if the maximum number of instances of the sound are already playing.</p>

    </div>

    
        <p><strong>Default:</strong> early</p>
    

    

    
</div>

                
                    <div id="property_INTERRUPT_LATE" class="property item">
    <h3 class="name"><code>INTERRUPT_LATE</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l282"><code>INTERRUPT_LATE:282</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The interrupt value to interrupt the currently playing instance with the same source that progressed the most
distance in the audio track, if the maximum number of instances of the sound are already playing.</p>

    </div>

    
        <p><strong>Default:</strong> late</p>
    

    

    
</div>

                
                    <div id="property_INTERRUPT_NONE" class="property item">
    <h3 class="name"><code>INTERRUPT_NONE</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l292"><code>INTERRUPT_NONE:292</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The interrupt value to not interrupt any currently playing instances with the same source, if the maximum number of
instances of the sound are already playing.</p>

    </div>

    
        <p><strong>Default:</strong> none</p>
    

    

    
</div>

                
                    <div id="property_muted" class="property item">
    <h3 class="name"><code>muted</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l516"><code>muted:516</code></a>
        
        </p>

        

        
            <p>Available since 0.6.1</p>
        
    </div>

    <div class="description">
        <p>Mute/Unmute all audio. Note that muted audio still plays at 0 volume. This global mute value is maintained
separately and when set will override, but not change the mute property of individual instances. To mute an individual
instance, use AbstractSoundInstance <a href="AbstractSoundInstance.html#property_muted" class="crosslink">muted</a> instead.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code>createjs.Sound.muted = true;</code></pre>

    </div>

    
        <p><strong>Default:</strong> false</p>
    

    

    
</div>

                
                    <div id="property_PLAY_FAILED" class="property item">
    <h3 class="name"><code>PLAY_FAILED</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l338"><code>PLAY_FAILED:338</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Defines the playState of an instance that failed to play. This is usually caused by a lack of available channels
when the interrupt mode was "INTERRUPT_NONE", the playback stalled, or the sound could not be found.</p>

    </div>

    
        <p><strong>Default:</strong> playFailed</p>
    

    

    
</div>

                
                    <div id="property_PLAY_FINISHED" class="property item">
    <h3 class="name"><code>PLAY_FINISHED</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l329"><code>PLAY_FINISHED:329</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Defines the playState of an instance that completed playback.</p>

    </div>

    
        <p><strong>Default:</strong> playFinished</p>
    

    

    
</div>

                
                    <div id="property_PLAY_INITED" class="property item">
    <h3 class="name"><code>PLAY_INITED</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l302"><code>PLAY_INITED:302</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Defines the playState of an instance that is still initializing.</p>

    </div>

    
        <p><strong>Default:</strong> playInited</p>
    

    

    
</div>

                
                    <div id="property_PLAY_INTERRUPTED" class="property item">
    <h3 class="name"><code>PLAY_INTERRUPTED</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l320"><code>PLAY_INTERRUPTED:320</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Defines the playState of an instance that was interrupted by another instance.</p>

    </div>

    
        <p><strong>Default:</strong> playInterrupted</p>
    

    

    
</div>

                
                    <div id="property_PLAY_SUCCEEDED" class="property item">
    <h3 class="name"><code>PLAY_SUCCEEDED</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l311"><code>PLAY_SUCCEEDED:311</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Defines the playState of an instance that is currently playing or paused.</p>

    </div>

    
        <p><strong>Default:</strong> playSucceeded</p>
    

    

    
</div>

                
                    <div id="property_SUPPORTED_EXTENSIONS" class="property item">
    <h3 class="name"><code>SUPPORTED_EXTENSIONS</code></h3>
    <span class="type">ArrayString</span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l348"><code>SUPPORTED_EXTENSIONS:348</code></a>
        
        </p>

        

        
            <p>Available since 0.4.0</p>
        
    </div>

    <div class="description">
        <p>A list of the default supported extensions that Sound will <i>try</i> to play. Plugins will check if the browser
can play these types, so modifying this list before a plugin is initialized will allow the plugins to try to
support additional media types.</p>
<p>NOTE this does not currently work for <a href="FlashAudioPlugin.html" class="crosslink">FlashAudioPlugin</a>.</p>
<p>More details on file formats can be found at <a href="http://en.wikipedia.org/wiki/Audio_file_format" target="_blank"><a href="http://en.wikipedia.org/wiki/Audio_file_format">http://en.wikipedia.org/wiki/Audio_file_format</a>.<br>
A very detailed list of file formats can be found at <a href="http://www.fileinfo.com/filetypes/audio" target="_blank"><a href="http://www.fileinfo.com/filetypes/audio">http://www.fileinfo.com/filetypes/audio</a>.</p>

    </div>

    
        <p><strong>Default:</strong> [&quot;mp3&quot;, &quot;ogg&quot;, &quot;opus&quot;, &quot;mpeg&quot;, &quot;wav&quot;, &quot;m4a&quot;, &quot;mp4&quot;, &quot;aiff&quot;, &quot;wma&quot;, &quot;mid&quot;]</p>
    

    

    
</div>

                
                    <div id="property_volume" class="property item">
    <h3 class="name"><code>volume</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l446"><code>volume:446</code></a>
        
        </p>

        

        
            <p>Available since 0.6.1</p>
        
    </div>

    <div class="description">
        <p>Set the master volume of Sound. The master volume is multiplied against each sound&#39;s individual volume.  For
example, if master volume is 0.5 and a sound&#39;s volume is 0.5, the resulting volume is 0.25. To set individual
sound volume, use AbstractSoundInstance <a href="AbstractSoundInstance.html#property_volume" class="crosslink">volume</a>
instead.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code>createjs.Sound.volume = 0.5;</code></pre>

    </div>

    
        <p><strong>Default:</strong> 1</p>
    

    

    
</div>

                
            </div>
        

        

        
            <div id="events" class="api-class-tabpanel">
                <h2 class="off-left">Events</h2>

                
                    <div id="event_fileerror" class="events item">
    <h3 class="name"><code>fileerror</code></h3>
    <span class="type"></span>

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l730"><code>fileerror:730</code></a>
        
        </p>

        

        
            <p>Available since 0.6.0</p>
        
    </div>

    <div class="description">
        <p>This event is fired when a file fails loading internally. This event is fired for each loaded sound,
so any handler methods should look up the <code>event.src</code> to handle a particular sound.</p>

    </div>

    
        <div class="params">
            <h4>Event Payload:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">target</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>The object that dispatched the event.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The event type.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">src</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The source of the sound that was loaded.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[id]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The id passed in when the sound was registered. If one was not provided, it will be null.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[data]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>Any additional data associated with the item. If not provided, it will be undefined.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    


    
</div>

                
                    <div id="event_fileload" class="events item">
    <h3 class="name"><code>fileload</code></h3>
    <span class="type"></span>

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/soundjs_Sound.js.html#l718"><code>fileload:718</code></a>
        
        </p>

        

        
            <p>Available since 0.4.1</p>
        
    </div>

    <div class="description">
        <p>This event is fired when a file finishes loading internally. This event is fired for each loaded sound,
so any handler methods should look up the <code>event.src</code> to handle a particular sound.</p>

    </div>

    
        <div class="params">
            <h4>Event Payload:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">target</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>The object that dispatched the event.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The event type.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">src</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The source of the sound that was loaded.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[id]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The id passed in when the sound was registered. If one was not provided, it will be null.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[data]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>Any additional data associated with the item. If not provided, it will be undefined.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    


    
</div>

                
            </div>
        
    </div>
</div>

                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>
